-
Notifications
You must be signed in to change notification settings - Fork 118
add documentation for NIC statefulset #1083
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall good but I think files were missed?
content/includes/nic/installation/deploy-controller.md
content/includes/nic/configuration/global-configuration/configmap-resource.md:202
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Adds documentation for NGINX Ingress Controller StatefulSet deployment type to support NIC v3.8.0 which introduces StatefulSet as a new deployment option alongside existing Deployment and DaemonSet types. The changes ensure comprehensive coverage of all three deployment methods in installation guides, configuration references, and troubleshooting documentation.
- Updates installation documentation to include StatefulSet as a third deployment option
- Adds StatefulSet-specific configuration parameters in Helm chart documentation
- Updates troubleshooting and logging guides to reference StatefulSet alongside Deployment/DaemonSet
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.
Show a summary per file
File | Description |
---|---|
content/nic/tutorials/oidc-custom-configuration.md | Updates OIDC tutorial to include StatefulSet in volume mount instructions |
content/nic/troubleshooting/troubleshoot-common.md | Adds StatefulSet reference to troubleshooting commands |
content/nic/overview/product-telemetry.md | Updates telemetry description to include StatefulSet replicas |
content/nic/logging-and-monitoring/service-insight.md | Includes StatefulSet in Service Insight installation options |
content/nic/logging-and-monitoring/prometheus.md | Updates Prometheus metrics guide to reference StatefulSet |
content/nic/installation/integrations/app-protect-waf/installation.md | Adds StatefulSet deployment option and volume configuration notes |
content/nic/installation/integrations/app-protect-waf-v5/installation.md | Includes StatefulSet in WAF v5 installation with volume guidance |
content/nic/installation/integrations/app-protect-dos/installation.md | Adds StatefulSet option to DoS installation guide |
content/nic/installation/installing-nic/installation-with-manifests.md | Updates main installation guide to include StatefulSet as third deployment option |
content/nic/installation/installing-nic/installation-with-helm.md | Adds StatefulSet-specific Helm chart parameters and configuration options |
content/nic/configuration/global-configuration/configmap-resource.md | Updates ConfigMap documentation to reference StatefulSet in zone-sync |
content/includes/nic/installation/manifests/statefulset.md | New include file with StatefulSet deployment instructions |
content/includes/nic/configuration/security.md | Updates security recommendations for StatefulSet volume configuration |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
content/nic/installation/integrations/app-protect-waf-v5/installation.md
Show resolved
Hide resolved
✅ Deploy Preview will be available once build job completes!
|
content/nic/installation/integrations/app-protect-waf/installation.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM on the basis of Jack's feedback being addressed.
All call-outs should use the new call-out format: there are warnings in the terminal about this when running Hugo locally.
Proposed changes
StatefulSet
NIC PR: StatefulSet support kubernetes-ingress#8159
Checklist
Before sharing this pull request, I completed the following checklist:
Footnotes
Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content. ↩